Transforms forReportBean


ReportOutlineModeTransformImpl

Formal Parameter Type Default Required Description
addNumberFormatting BOOLEAN true false Whether to add the number formatting on metric values.
advancedDrillingContextMenuDisplay INTEGER 1 false It is used in the transform to specify whether to show the advanced drilling options in the editor or context menu.
Allowed Values: PreferencesDrillTransform.ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT = "1"
ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU = "2"
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
containerHeight STRING -1 false Specifies the height (in any measure accepted by the web-browser) of the <div> tag enclosing the grid's table. Only used when the ReportGridTransformImpl.heightMode is set to be fixed.
containerWidth STRING -1 false Specifies the width (in any measure accepted by the web-browser) of the <div> tag enclosing the grid's table. Only used when the ReportGridTransformImpl.widthMode is set to be fixed.
contextMenuName STRING   false This is the parameter to define the name of the context menu to use.
Allowed Values: String values.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssBottom STRING bottom false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the bottom area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssCenter STRING center false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the center area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssErrorMessage STRING error-message false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error message.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssErrorTitle STRING error-title false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error title.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssLeft STRING left false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the left area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssOutlineModeContractImage STRING outlinemode-contract false

Deprecated.


This is the css name for the contract image used in the outline mode grid display.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssOutlineModeExpandImage STRING outlinemode-expand false

Deprecated.


This is the css name for the expand image used in the outline mode grid display.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssOutlineModeLevelCell STRING outlinemode-level-cells false

Deprecated.


This is the css name for the cells used to show the outline mode levels at the top of the report.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssOutlineModeLevelTable STRING outlinemode-level-table false

Deprecated.


This is the css name for the table used to show the outline mode levels at the top of the report.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssParentFontSize FLOAT 10.0 false This is the report's base font size.
Used when generating the report's CSS classes with the WebCSSHelper.
Allowed Values: positive integer values.
cssPathParameter STRING mstrWeb . false Determines the CSS class path to for all CSS classes in a grid report.
This class will be appended as a prefix to all the CSS classes generated by the WebCSSHelper with a '.' at the beginning
cssPrefix STRING   false Prefix to append to all css class names.
cssRight STRING right false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the right area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssTop STRING top false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the top area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssUseFileContent BOOLEAN false false This is the flag used in the transform to specify whether to show a link to the CSS file or the whole CSS file content.
Allowed Values: TRUE/FALSE.
cssUseRelativeFont BOOLEAN false false Determines whether to use relative font for the CSS.
Used when generating the report's CSS classes with the WebCSSHelper.
It should be of BOOLEAN type.
customJavaScriptFeatures STRING   false name for the formal parameter "customJavaScriptFeatures".
datasetID STRING   false  
datasetName STRING   false  
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
dpiConversion INTEGER 96 false Indicates the dpi conversion factor to convert between inches and pixels (inches=pixels/dpiConversion).
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    drillLinkExtraURL STRING   false This is the code which we will append with the drill hyperlink tag for DHTML.
    Allowed Values: String values.
    drillRetainParent STRING 3 false This is the FP which tells whether to retain the parent while drilling.
    If a value is specified here, then the drill Preference on the preference page for the same is ignored.
    Allowed Values:
    PreferencesDrillTransform.DRILL_OPTION_DRILL_ANYWHERE = "1";
    PreferencesDrillTransform.DRILL_OPTION_DRILL_HYPERLINKS = "2";
    PreferencesDrillTransform.DRILL_OPTION_SIMPLE_DRILL = "3";
    PreferencesDrillTransform.DRILL_OPTION_NO_DRILL = "4";
    PreferencesDrillTransform.DRILL_OPTION_REPORT_DEFINITION = "5";
    drillRetainThresholds STRING 3 false This is the FP which tells whether to retain the thresholds while drilling. If a value is specified here, then the drill Preference on the preference page for the same is ignored. This value can be 1(to retain), 0(to not retain) or 2(to use the drill path for the value). If blank the drill preference is used. Allowed Values:
    PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_YES = "1";
    PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_NO = "2";
    PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION = "3";
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    gridClassesConfFile STRING gridClasses.properties false It is used to indicate the name and location of the properties file containing the definition of the grid classes to use.
    gridGraphUnitKeyContext STRING   false This formal parameter indicates the unique Id of the RWGridGraphControl. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
    Any String
    groupContextMenuDrillPathsByType BOOLEAN false false Determines whether drill types (up, down, across and to template) will be displayed as read from the backend in which case the drill types may be intermingled or that we will buck the types together and show the types grouped together. The order will be up, down, across and to template. Default is false. Allowed Values: TRUE/FALSE.
    headerMetricValueOptimized BOOLEAN true false This is the parameter which decides if we move the common html attributes of non-metric headers and metric value cells to a map and is thus stored once. Allowed Values: TRUE/FALSE.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    heightMode INTEGER -1 false

    Determines whether the <div> tag enclosing the grid should have a fixed height, or should expand to fit the height of the grid's content.

    Allowed values:
    • 0-Fixed
    • 2-Fit to contents
    When the height is set to be fixed, then the ReportGridTransformImpl.containerHeight property must also be specified.
    hideMetricsLabel BOOLEAN false false Hides the 'Metrics' label on the grid's titles.
    Allowed Values: TRUE/FALSE.
    id STRING   false It is used to identify the outer shell for all report modes - grid, graph and gridgraph. (Firefox issue: 246019)
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    ignoreSubtotal BOOLEAN false false It is used in the transform to specify whether to display subtotal cells.
    Allowed Values: TRUE/FALSE.
    imgActiveSortAsc STRING sort_asc.gif false This is the image name for showing the active sort icon for ascending values.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgActiveSortDesc STRING sort_desc.gif false This is the image name for showing the active sort icon for descending values.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgError STRING jobError.gif false This is the Image to display when there bean is in Error status.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgInActiveSortAsc STRING sort_row.gif false This is the image name for showing the inactive sort icon for ascending values.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgInActiveSortDesc STRING sort.gif false This is the image name for showing the inactive sort icon for descending values.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgOutlineContract STRING contract.gif false This is the image name for collapsing the Outline Mode grid data.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgOutlineExpand STRING expand.gif false This is the image name for expanding the Outline Mode grid data.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgRemove STRING remove.gif false This is the image name for remove image used in the transform.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgRightDown STRING arrow_rightdown.gif false

    Deprecated.


    This is the image name for pivot-to-cols image used in the transform.
    Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgShiftDown STRING arrow_shiftdown.gif false This is the image name for shift down arrow used in the transform.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgShiftLeft STRING arrow_shiftleft.gif false This is the image name for shift left arrow used in the transform.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgShiftLeftDown STRING arrow_leftdown.gif false This is the image name for shift left down arrow (pivot to row) used in the transform.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgShiftRight STRING arrow_shiftright.gif false This is the image name for shift right arrow used in the transform.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgShiftRightUp STRING arrow_rightup.gif false This is the image name for shift right up arrow (pivot to column) used in the transform.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgShiftUp STRING arrow_shiftup.gif false This is the image name for shift up arrow used in the transform.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgToPageBy STRING arrow_topageby.gif false This is the image name for to-page-by image used in the transform.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    incrementalFetchStyleForRow STRING ReportStyleIncrementalFetch_2 false This is the name of the style used to show the incremental fetch for row.
    Allowed Values: any report style name from StyelCatalog.xml file.
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    isContextMenuEnabled BOOLEAN true false

    Deprecated.


    This is the flag used in the transform to specify whether to enable context menu functionality.
    Allowed Values: TRUE/FALSE.
    isHTMLExport BOOLEAN false false  
    maxSortAllowed INTEGER 3 false This is the value used in the transform to specify how many nested sorts will be allowed in the report.
    Allowed Values: positive integer values.
    outlineModeDefaultLevelMax BOOLEAN true false

    Deprecated.


    If this value is set to true the default level at which any newly run report wil open for outline mode will be maximum expanded.
    If it is false, the default will be fully collapsed.
    This property will be used only if the report property denoting the outline mode level is not present.
    Allowed Values: String values.
    outlineModeLevelTableID STRING outlinemodeLevelTableID false

    Deprecated.


    This is the ID for the table used to show the outline mode levels at the top of the report.
    Allowed Values: String value representing an ID.
    outlineModeState STRING   false This is an XML representation of the outline mode expansion state.
    Allowed Values: String with an XML representation of the outline mode expansion state.
    outlineModeSupressDuplicateSubTotals BOOLEAN true false If this is set to true we will supress the duplication of sub totals in outline mode except for the case when the metrics are on the rows.
    Allowed Values: boolean true or false.
    overflowMode INTEGER 0 false

    If the ReportGridTransformImpl.widthMode or ReportGridTransformImpl.heightMode is set to be fixed, this parameter specifies what should happen with the <div>'s content if it overflows the space specified by the ReportGridTransformImpl.containerHeight or ReportGridTransformImpl.containerWidth parameters.

    Allowed values:
    • 0-Clipped: The content is clipped, and it's not visible
    • 1-Scroll: The content is clipped but scrollbars are enabled.
    postTextForMetricValue STRING   false This is the post text for the metric value cell content. Most likely used with exporting feature.
    Allowed Values: String values.
    postTextForNonMetricValue STRING   false This is the post text for the non-metric value cell content. Most likely used with exporting feature.
    Allowed Values: String values.
    preTextForMetricValue STRING   false This is the pre text for the metric value cell content. Most likely used with exporting feature.
    Allowed Values: String values.
    preTextForNonMetricValue STRING   false This is the pre text for the non-metric value cell content. Most likely used with exporting feature.
    Allowed Values: String values.
    quickSwitch BOOLEAN false false This formal parameter indicates if the grid is going to have the Quick Switch functionality (client side view mode change enabler) enabled. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
    True and False
    returnReplacement STRING   false This is the substring that when found in the cell will be replaced by a break (<br>) tag.
    Allowed Values: String values.
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    showBanding BOOLEAN false false

    Deprecated.


    It is used in the transform to specify whether to show banding. It only applies to reports that don't use built-in formattings (i.e. reports from old projects).
    Allowed Values: TRUE/FALSE.
    showContextMenus BOOLEAN true false

    Deprecated. This formal parameter is not referenced anywhere in the code. Use isContextMenuEnabled instead


    It is used in the transform to specify whether to enable context menu functionality.
    Allowed Values: TRUE/FALSE.
    showDescriptionAsTooltip INTEGER 0 false It is used in the transform to specify whether to show the descriptions in the tooltip for the row or column titles.
    It should be of BOOLEAN type.
    Allowed Values: "1" means TRUE, "0" means FALSE.
    showDrillCheckBox BOOLEAN true false It is used in the transform to specify whether to allow select filter - check box drilling.
    Allowed Values: TRUE/FALSE.
    showDrillPathSetNamesSubMenuAtTopLevel BOOLEAN true false It is used in the transform to specify whether to show the set names submenu for drilling at the top level (or at a lower depth).
    Allowed Values: TRUE/FALSE.
    showFilterOnSelectionCheckBox BOOLEAN true false It is used in the transform to specify whether to allow filter on selection.
    Allowed Values: TRUE/FALSE.
    showGridInFullWidth BOOLEAN true false

    Deprecated.


    It is used in the transform to specify whether to show the grid in full width.
    If TRUE, the grid will expand to the complete browser window; If FALSE, the grid will fit to the content in each cell. Allowed Values: TRUE/FALSE.
    showIncreFetchForColumn BOOLEAN true false

    Deprecated.


    It is used in the transform to specify whether to show increfetch links on column.
    Allowed Values: TRUE/FALSE.
    showIncreFetchForRowOnBottom BOOLEAN true false

    Deprecated.


    It is used in the transform to specify whether to show increfetch links for rows at the bottom of the grid.
    Allowed Values: TRUE/FALSE.
    showIncreFetchForRowOnTop BOOLEAN false false

    Deprecated.


    It is used in the transform to specify whether to show increfetch links for rows on top of the grid.
    Allowed Values: TRUE/FALSE.
    showRenameRMC BOOLEAN true false This is the flag used in the transform to specify whether to show Right Mouse Click menu for renaming.
    Allowed Values: TRUE/FALSE.
    showSortButtonsForAttributes BOOLEAN true false This is the flag used in the transform to specify whether to show sort buttons for attributes (row titles).
    Allowed Values: TRUE/FALSE.
    showSortButtonsForMetrics BOOLEAN true false This is the flag used in the transform to specify whether to show sort buttons for metrics (column headers).
    Allowed Values: TRUE/FALSE.
    showSortRMCForAttributes BOOLEAN true false This is the flag used in the transform to specify whether to show sort right mouse click menu for attributes (row titles).
    Allowed Values: TRUE/FALSE.
    showSortRMCForMetrics BOOLEAN true false This is the flag used in the transform to specify whether to show sort right mouse click menu for metrics (column headers).
    Allowed Values: TRUE/FALSE.
    showSubtitle STRING 3 false Controls whether subtitles (attribute forms) are to be displayed for this grid. Allowed Values:
    showUniqueDrillPaths BOOLEAN false false It is used in the transform to specify whether to show unique drill paths on context menus.
    Allowed Values: TRUE/FALSE.
    sortSetNamesAndDrillPaths BOOLEAN false false It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
    Allowed Values: TRUE/FALSE.
    staticOutlineMode BOOLEAN false false This will indicate if we want a static or non static outline mode.
    In static outline mode we will not execute or render any of the Javascript associated with outline mode. In HTML mode the oultine mode transform will always be static irrespective of the value of this formal parameter. Allowed Values: true or false.
    treeType STRING 1 false  
    uniqueReportId STRING UniqueReportID false This is the name of the HTML DIV for the report. It's used as the unique identifier of the grid's bone.
    Allowed Values: String values.
    useBuiltInFormat BOOLEAN true false This is the flag used in the transform to specify whether to use the formatting info from the report definition.
    Out of box, we map the first preference in Grid preferences section to this formal parameter.
    If it's TRUE, WebCSSHelper.getCSS() will give the css class definitions, which is from report formatting defintion.
    If it's FALSE, a specified css file will give the css class definitions, which is what formal paramter cssFile means.
    Allowed Values: TRUE/FALSE.
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    useImageOnEmptyCells BOOLEAN false false It is used in the transform to specify the use of transparent image on empty metric cells.
    Allowed Values: TRUE/FALSE.
    It is recommended for this formal paramter to be set to false, as using images for empty cells might degrade performance.
    useImagesForOutlineMode BOOLEAN false false If this is set to true we will use the contract and expand images to denote outline mode, if set to false we will use text to display those states.
    Allowed Values: boolean true or false.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    widthMode INTEGER -1 false

    Determines whether the <div> tag enclosing the grid should have a fixed width, or should expand to fit the width of the grid's content.

    Allowed values:
    • 0-Fixed
    • 2-Fit to contents
    When the width is set to be fixed, then the ReportGridTransformImpl.containerWidth property must also be specified.
    wrapMetricValue BOOLEAN false false This is the parameter which decides if we wrap the metric values cells when displaying the report. It was added to support older browsers that ignore WordWrap in css (which is how the Word Wrap property in the grid formatting dialog works). In newer browsers, the user has complete control. It's usually mapped to the "wrapRowHeader" preference (set at the project level by the administrator) and set through the style catalog. It affects the transform's output as follow:
    1. If true, users with Internet Explorer 5.5 and greater-word wrapping is controlled by the "Wrap text" setting on the Format panel (on the Alignment tab); users with Internet Explorer 5.0 and less and Netscape Navigator 4.7-word wrapping is allowed in all attribute element cells.
    2. When false, users with IE 5.5 and greater-word wrapping for the attribute element cells that are in the rows (on the left of the grid) is not allowed. Word wrapping in all other cells is still controlled by the "Wrap text" setting on the Format panel (on the Alignment tab); users with Internet Explorer 5.0 and below-word wrapping for the attribute element cells that are in the rows (on the left of the grid) is not allowed. Word wrapping is allowed in all other cells.
    Allowed Values: TRUE/FALSE.
    wrapRowHeader BOOLEAN true false This is the parameter which decides if we wrap the row header cells when displaying the report. It was added to support older browsers that ignore WordWrap in css (which is how the Word Wrap property in the grid formatting dialog works). In newer browsers, the user has complete control. It's usually mapped to the "wrapRowHeader" preference (set at the project level by the administrator) and set through the style catalog. It affects the transform's output as follow:
    1. If true, users with Internet Explorer 5.5 and greater-word wrapping is controlled by the "Wrap text" setting on the Format panel (on the Alignment tab); users with Internet Explorer 5.0 and less and Netscape Navigator 4.7-word wrapping is allowed in all attribute element cells.
    2. When false, users with IE 5.5 and greater-word wrapping for the attribute element cells that are in the rows (on the left of the grid) is not allowed. Word wrapping in all other cells is still controlled by the "Wrap text" setting on the Format panel (on the Alignment tab); users with Internet Explorer 5.0 and below-word wrapping for the attribute element cells that are in the rows (on the left of the grid) is not allowed. Word wrapping is allowed in all other cells.
    Allowed Values: TRUE/FALSE.